start

open fun start()

Starts or resumes the active operation of this control.

This typically involves starting content playback, animations, data fetching, or making the control visually active. If the control was previously #stop() stopped, this method should resume its operation. Calling start()} on an already started control should ideally be a no-op or handle resumption gracefully.

This method might be called automatically after #initialize(Module) if #isAutoStart() is true, or explicitly by the player system.

Signals the loaded gadget that it should start or resume its primary operations. This is typically called when the gadget becomes visible or active.

If the gadget has not yet finished its initial loading (isInitialized is false), this method does nothing. In such cases, the actual "start" signal (calling RevelDigital.Controller.onStart() and dispatching the "RevelDigital.Start" event) is deferred until the onPageFinished callback is triggered, which indicates the gadget's content is fully loaded and ready.

If the gadget is already initialized, this method will:

  1. Execute the JavaScript function RevelDigital.Controller.onStart() if it exists within the gadget's context.
  2. Trigger a custom DOM event named "RevelDigital.Start" on the document, which the gadget can listen for.
This dual mechanism ensures that gadgets conforming to either the direct function call pattern or the event listener pattern receive the start signal.

See also

isInitialized
triggerJavascriptEvent(String, String)